<!--

     Licensed to the Apache Software Foundation (ASF) under one
     or more contributor license agreements.  See the NOTICE file
     distributed with this work for additional information
     regarding copyright ownership.  The ASF licenses this file
     to you under the Apache License, Version 2.0 (the
     "License"); you may not use this file except in compliance
     with the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

     Unless required by applicable law or agreed to in writing,
     software distributed under the License is distributed on an
     "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     KIND, either express or implied.  See the License for the
     specific language governing permissions and limitations
     under the License.

-->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- **************************************************************** -->
<!-- *  PLEASE KEEP COMPLICATED EXPRESSIONS OUT OF THESE TEMPLATES, * -->
<!-- *  i.e. only iterate & print data where possible. Thanks, Jez. * -->
<!-- **************************************************************** -->

<html>
<head>
    <!-- Generated by groovydoc (2.4.5) on Mon Sep 12 08:35:25 CEST 2016 -->
    <title>ShellServer (Groovy Documentation)</title>
    <meta name="date" content="2016-09-12">
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <link href="../../../../../groovy.ico" type="image/x-icon" rel="shortcut icon">
    <link href="../../../../../groovy.ico" type="image/x-icon" rel="icon">
    <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">

<body class="center">
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
    parent.document.title="ShellServer (Groovy Documentation)";
}
//-->
</script>
<noscript>
    <div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
    <!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
    <!--   -->
</a>
    <ul class="navList" title="Navigation">
        <li><a href="../../../../../overview-summary.html">Overview</a></li>
        <li><a href="package-summary.html">Package</a></li>
        <li class="navBarCell1Rev">Class</li>
        <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
        <li><a href="../../../../../index-all.html">Index</a></li>
        <li><a href="../../../../../help-doc.html">Help</a></li>
    </ul>
</div>

<div class="subNav">
    <div>
        <ul class="navList">
            <li><a href="../../../../../index.html?io/vertx/groovy/ext/shell/ShellServer" target="_top">Frames</a></li>
            <li><a href="ShellServer.html" target="_top">No Frames</a></li>
        </ul>
    </div>
    <div>
        <ul class="subNavList">
            <li>Summary:&nbsp;</li>
            Nested&nbsp;&nbsp;&nbsp;Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#constructor_summary">Constructor</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#method_summary">Method</a></li>&nbsp;&nbsp;&nbsp;
        </ul>
        <ul class="subNavList">
            <li>&nbsp;|&nbsp;Detail:&nbsp;</li>
            Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#constructor_detail">Constructor</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#method_detail">Method</a></li>&nbsp;&nbsp;&nbsp;
        </ul>
    </div>
    <a name="skip-navbar_top">
        <!--   -->
    </a></div>
<!-- ========= END OF TOP NAVBAR ========= -->

<!-- ======== START OF CLASS DATA ======== -->
<div class="header">

    <div class="subTitle">Package: <strong>io.vertx.groovy.ext.shell</strong></div>

    <h2 title="[Groovy] Class ShellServer" class="title">[Groovy] Class ShellServer</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><ul class="inheritance"></ul></li><li>io.vertx.groovy.ext.shell.ShellServer
</ul>
<div class="description">
    <ul class="blockList">
        <li class="blockList">



    <p> The shell server.<p/>

 A shell server is associated with a collection of : the <a href='../../../../../io/vertx/groovy/ext/shell/ShellServer.html#registerTermServer' title='ShellServer.registerTermServer'>ShellServer.registerTermServer</a>
 method registers a term server. Term servers life cycle are managed by this server.<p/>

 When a  receives an incoming connection, a  instance is created and
 associated with this connection.<p/>

 The <a href='../../../../../io/vertx/groovy/ext/shell/ShellServer.html#createShell' title='ShellServer.createShell'>ShellServer.createShell</a> method can be used to create  instance for testing purposes.
</p>

          </li>
    </ul>
</div>

<div class="summary">
    <ul class="blockList">
        <li class="blockList">
        <!-- =========== NESTED CLASS SUMMARY =========== -->
        

        <!-- =========== ENUM CONSTANT SUMMARY =========== -->
        
        <!-- =========== FIELD SUMMARY =========== -->
        

        <!-- =========== PROPERTY SUMMARY =========== -->
        

        <!-- =========== ELEMENT SUMMARY =========== -->
        

        
        <!-- ======== CONSTRUCTOR SUMMARY ======== -->
        <ul class="blockList">
                <li class="blockList"><a name="constructor_summary"><!--   --></a>
                    <h3>Constructor Summary</h3>
                    <ul class="blockList">
                    <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructors Summary table">
                        <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
                        <tr>
                            <th class="colFirst" scope="col">Constructor and description</th>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst">
                                <code><a href="#ShellServer(java.lang.Object)">ShellServer</a></strong>
                                (java.lang.Object delegate)</code><br></td>
                        </tr>
                        
                    </table>
                   </ul>
              </li>
        </ul>
        

        
        <!-- ========== METHOD SUMMARY =========== -->
        <ul class="blockList">
            
            <li class="blockList"><a name="method_summary"><!--   --></a>
                    <h3>Methods Summary</h3>
                    <ul class="blockList">
                    <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Methods Summary table">
                        <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
                        <tr>
                            <th class="colFirst" scope="col">Type</th>
                            <th class="colLast" scope="col">Name and description</th>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code>void</strong></code></td>
                            <td class="colLast"><code><strong><a href="#close()">close</a></strong>()</code><br>Close the shell server, this is an asynchronous close.</td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code>void</strong></code></td>
                            <td class="colLast"><code><strong><a href="#close(Handler<AsyncResult<Void>>)">close</a></strong>(io.vertx.core.Handler&lt;io.vertx.core.AsyncResult&lt;java.lang.Void&gt;&gt; completionHandler)</code><br>Close the shell server, this is an asynchronous close.</td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code>static&nbsp;<a href='../../../../../io/vertx/groovy/ext/shell/ShellServer.html'>ShellServer</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#create(io.vertx.groovy.core.Vertx, Map<String, Object>)">create</a></strong>(<a href='../../../../../io/vertx/groovy/core/Vertx.html'>Vertx</a> vertx, java.util.Map&lt;java.lang.String, java.lang.Object&gt; options)</code><br>Create a new shell server with default options.</td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code>static&nbsp;<a href='../../../../../io/vertx/groovy/ext/shell/ShellServer.html'>ShellServer</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#create(io.vertx.groovy.core.Vertx)">create</a></strong>(<a href='../../../../../io/vertx/groovy/core/Vertx.html'>Vertx</a> vertx)</code><br>Create a new shell server with specific options.</td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code><a href='../../../../../io/vertx/groovy/ext/shell/Shell.html'>Shell</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#createShell(io.vertx.groovy.ext.shell.term.Term)">createShell</a></strong>(<a href='../../../../../io/vertx/groovy/ext/shell/term/Term.html'>Term</a> term)</code><br>Create a new shell, the returned shell should be closed explicitely.</td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code><a href='../../../../../io/vertx/groovy/ext/shell/Shell.html'>Shell</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#createShell()">createShell</a></strong>()</code><br>Create a new shell, the returned shell should be closed explicitely.</td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code>java.lang.Object</strong></code></td>
                            <td class="colLast"><code><strong><a href="#getDelegate()">getDelegate</a></strong>()</code><br></td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code><a href='../../../../../io/vertx/groovy/ext/shell/ShellServer.html'>ShellServer</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#listen()">listen</a></strong>()</code><br>Start the shell service, this is an asynchronous start.
 </td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code><a href='../../../../../io/vertx/groovy/ext/shell/ShellServer.html'>ShellServer</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#listen(Handler<AsyncResult<Void>>)">listen</a></strong>(io.vertx.core.Handler&lt;io.vertx.core.AsyncResult&lt;java.lang.Void&gt;&gt; listenHandler)</code><br>Start the shell service, this is an asynchronous start.</td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code><a href='../../../../../io/vertx/groovy/ext/shell/ShellServer.html'>ShellServer</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#registerCommandResolver(io.vertx.groovy.ext.shell.command.CommandResolver)">registerCommandResolver</a></strong>(<a href='../../../../../io/vertx/groovy/ext/shell/command/CommandResolver.html'>CommandResolver</a> resolver)</code><br>Register a command resolver for this server.</td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code><a href='../../../../../io/vertx/groovy/ext/shell/ShellServer.html'>ShellServer</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#registerTermServer(io.vertx.groovy.ext.shell.term.TermServer)">registerTermServer</a></strong>(<a href='../../../../../io/vertx/groovy/ext/shell/term/TermServer.html'>TermServer</a> termServer)</code><br>Register a term server to this shell server, the term server lifecycle methods are managed by this shell server.</td>
                        </tr>
                        
                    </table>
                   </ul>
              </li>
            
            <li class="blockList"><a name="method_summary"><!--   --></a>
                    <h3>Inherited Methods Summary</h3>
                    <ul class="blockList">
                    <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Inherited Methods Summary table">
                        <caption><span>Inherited Methods</span><span class="tabEnd">&nbsp;</span></caption>
                        <tr>
                            <th class="colFirst" scope="col">Methods inherited from class</th>
                            <th class="colLast" scope="col">Name</th>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code>class java.lang.Object</strong></code></td>
                            <td class="colLast"><code>java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()</code></td>
                        </tr>
                    </table>
                   </ul>
              </li>
                
        </ul>
        
    </li>
    </ul>
</div>

<div class="details">
    <ul class="blockList">
        <li class="blockList">
           

            

            

            

            
            <!-- =========== CONSTRUCTOR DETAIL =========== -->
            <ul class="blockList">
                <li class="blockList"><a name="constructor_detail">
                    <!--   -->
                </a>
                    <h3>Constructor Detail</h3>
                    
                        <a name="ShellServer(java.lang.Object)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><strong>ShellServer</strong>(java.lang.Object delegate)</h4>
                                <p></p>
                            </li>
                        </ul>
                    
                </li>
            </ul>
            


            
            <!-- =========== METHOD DETAIL =========== -->
            <ul class="blockList">
                <li class="blockList"><a name="method_detail">
                    <!--   -->
                </a>
                    <h3>Method Detail</h3>
                    
                        <a name="close()"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>void <strong>close</strong>()</h4>
                                <p> Close the shell server, this is an asynchronous close.
   </p>
                            </li>
                        </ul>
                    
                        <a name="close(Handler<AsyncResult<Void>>)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>void <strong>close</strong>(io.vertx.core.Handler&lt;io.vertx.core.AsyncResult&lt;java.lang.Void&gt;&gt; completionHandler)</h4>
                                <p> Close the shell server, this is an asynchronous close.
   <DL><DT><B>Parameters:</B></DT><DD><code>completionHandler</code> -  handler for getting notified when service is stopped</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="create(io.vertx.groovy.core.Vertx, Map<String, Object>)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>static&nbsp;<a href='../../../../../io/vertx/groovy/ext/shell/ShellServer.html'>ShellServer</a> <strong>create</strong>(<a href='../../../../../io/vertx/groovy/core/Vertx.html'>Vertx</a> vertx, java.util.Map&lt;java.lang.String, java.lang.Object&gt; options)</h4>
                                <p> Create a new shell server with default options.
   <DL><DT><B>Returns:</B></DT><DD>the created shell server</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>vertx</code> -  the vertx</DD><DD><code>options</code> -  the options (see <a href="../../../../../../../cheatsheet/ShellServerOptions.html">ShellServerOptions</a>)</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="create(io.vertx.groovy.core.Vertx)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>static&nbsp;<a href='../../../../../io/vertx/groovy/ext/shell/ShellServer.html'>ShellServer</a> <strong>create</strong>(<a href='../../../../../io/vertx/groovy/core/Vertx.html'>Vertx</a> vertx)</h4>
                                <p> Create a new shell server with specific options.
   <DL><DT><B>Returns:</B></DT><DD>the created shell server</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>vertx</code> -  the vertx</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="createShell(io.vertx.groovy.ext.shell.term.Term)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><a href='../../../../../io/vertx/groovy/ext/shell/Shell.html'>Shell</a> <strong>createShell</strong>(<a href='../../../../../io/vertx/groovy/ext/shell/term/Term.html'>Term</a> term)</h4>
                                <p> Create a new shell, the returned shell should be closed explicitely.
   <DL><DT><B>Returns:</B></DT><DD>the created shell</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>term</code> -  the shell associated terminal</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="createShell()"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><a href='../../../../../io/vertx/groovy/ext/shell/Shell.html'>Shell</a> <strong>createShell</strong>()</h4>
                                <p> Create a new shell, the returned shell should be closed explicitely.
   <DL><DT><B>Returns:</B></DT><DD>the created shell</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="getDelegate()"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>java.lang.Object <strong>getDelegate</strong>()</h4>
                                <p></p>
                            </li>
                        </ul>
                    
                        <a name="listen()"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><a href='../../../../../io/vertx/groovy/ext/shell/ShellServer.html'>ShellServer</a> <strong>listen</strong>()</h4>
                                <p> Start the shell service, this is an asynchronous start. <DL><DT><B>Returns:</B></DT><DD></DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="listen(Handler<AsyncResult<Void>>)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><a href='../../../../../io/vertx/groovy/ext/shell/ShellServer.html'>ShellServer</a> <strong>listen</strong>(io.vertx.core.Handler&lt;io.vertx.core.AsyncResult&lt;java.lang.Void&gt;&gt; listenHandler)</h4>
                                <p> Start the shell service, this is an asynchronous start. <DL><DT><B>Returns:</B></DT><DD></DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>listenHandler</code> -  handler for getting notified when service is started</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="registerCommandResolver(io.vertx.groovy.ext.shell.command.CommandResolver)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><a href='../../../../../io/vertx/groovy/ext/shell/ShellServer.html'>ShellServer</a> <strong>registerCommandResolver</strong>(<a href='../../../../../io/vertx/groovy/ext/shell/command/CommandResolver.html'>CommandResolver</a> resolver)</h4>
                                <p> Register a command resolver for this server.
   <DL><DT><B>Returns:</B></DT><DD>a reference to this, so the API can be used fluently</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>resolver</code> -  the resolver</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="registerTermServer(io.vertx.groovy.ext.shell.term.TermServer)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4><a href='../../../../../io/vertx/groovy/ext/shell/ShellServer.html'>ShellServer</a> <strong>registerTermServer</strong>(<a href='../../../../../io/vertx/groovy/ext/shell/term/TermServer.html'>TermServer</a> termServer)</h4>
                                <p> Register a term server to this shell server, the term server lifecycle methods are managed by this shell server.
   <DL><DT><B>Returns:</B></DT><DD>a reference to this, so the API can be used fluently</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>termServer</code> -  the term server to add</DD></DL></p>
                            </li>
                        </ul>
                    
                </li>
            </ul>
            
        </li>
    </ul>
</div>

<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
    <!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
    <!--   -->
</a>
    <ul class="navList" title="Navigation">
        <li><a href="../../../../../overview-summary.html">Overview</a></li>
        <li><a href="package-summary.html">Package</a></li>
        <li class="navBarCell1Rev">Class</li>
        <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
        <li><a href="../../../../../index-all.html">Index</a></li>
        <li><a href="../../../../../help-doc.html">Help</a></li>
    </ul>
</div>

<div class="subNav">
    <div>
        <ul class="navList">
            <li><a href="../../../../../index.html?io/vertx/groovy/ext/shell/ShellServer" target="_top">Frames</a></li>
            <li><a href="ShellServer.html" target="_top">No Frames</a></li>
        </ul>
    </div>
    <div>
        <ul class="subNavList">
            <li>Summary:&nbsp;</li>
            Nested&nbsp;&nbsp;&nbsp;Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#constructor_summary">Constructor</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#method_summary">Method</a></li>&nbsp;&nbsp;&nbsp;
        </ul>
        <ul class="subNavList">
            <li>&nbsp;|&nbsp;Detail:&nbsp;</li>
            Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#constructor_detail">Constructor</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#method_detail">Method</a></li>&nbsp;&nbsp;&nbsp;
        </ul>
    </div>
    <p>Groovy Documentation</p>
    <a name="skip-navbar_bottom">
        <!--   -->
    </a>
    </div>
</div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>